Skip to content

feat(website): show each GitHub release's notes in the changelog - #20

Merged
diecodev merged 3 commits into
ci/staged-releasefrom
feat/changelog-from-releases
Oct 30, 2026
Merged

diecodev merged 3 commits into
ci/staged-releasefrom
feat/changelog-from-releases

Conversation

@diecodev

@diecodev diecodev commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

The changelog's notes now come from the GitHub releases instead of the hand-written src/lib/changelog.ts, which is deleted. Release notes are written in one place: the draft release.

  • src/lib/github.ts reads the published releases when the site builds and skips drafts, so a version's notes show only once it's approved on npm. It reads them as GitHub renders them (body_html, sanitized by GitHub).
    • In GitHub Actions it uses the workflow's token, and the build fails if it can't read the releases.
    • Locally and in previews it warns and builds without notes.
  • The page lists every version on npm, newest first, with filters by major. Each version shows its date and dist-tags from npm and links to npm, the GitHub release and the commits.
  • website.yml and the CI's site build pass GITHUB_TOKEN.

The old releases already have the curated notes that lived in changelog.ts: 14 releases were edited. v0.2.2 and v0.3.3 keep their notes, and v0.4.0 and v0.4.1 have no release.

Checks:

  • build.types, lint and the full SSG build pass in website/.
  • The prerendered page lists all 18 versions, 16 of them with notes.
  • Checked in light mode, dark mode and at 390px: no horizontal overflow.
  • With a mocked fetch, the reader handles being offline, the GitHub Actions failure path and pagination.

The changelog lists every version on npm with the notes of its GitHub release, read when the site builds (as GitHub renders them), instead of the hand-written notes in changelog.ts. Drafts are left out, so a version's notes show up once it is approved on npm.
@diecodev
diecodev added this pull request to stack #21 October 30, 2026 01:30
@diecodev diecodev changed the title feat/changelog from releases feat(website): show each GitHub release's notes in the changelog Oct 30, 2026
@diecodev
diecodev merged commit d8a68ea into v2 Oct 30, 2026
3 of 4 checks passed
@diecodev
diecodev deleted the feat/changelog-from-releases branch October 30, 2026 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant